Create Annotations

Create an annotation for an item

Request
path Parameters
itemId
required
string

Item id

Request Body schema: application/json

Annotations to be created

Any of:

Annotations to be created

id
string
creator
string
type
string (AnnotationType)
Enum: "class" "point" "line" "box" "cube" "segment" "ellipse" "binary" "note" "polyline" "comparison" "recording" "subtitle" "item_description" "text_mark" "pose" "cube_3d" "semantic_3d" "polyline_3d" "pdf_text" "text" "ref_image" "ref_semantic_3d" "class" "point" "line" "box" "cube" "segment" "ellipse" "binary" "note" "polyline" "comparison" "recording" "subtitle" "item_description" "text_mark" "pose" "cube_3d" "semantic_3d" "polyline_3d" "pdf_text" "text" "ref_image" "ref_semantic_3d" "class" "point" "line" "box" "cube" "segment" "ellipse" "binary" "note" "polyline" "comparison" "recording" "subtitle" "item_description" "text_mark" "pose" "cube_3d" "semantic_3d" "polyline_3d" "pdf_text" "text"
label
string
Point (object) or Array of Point (objects) or Array of Point (objects) or APINoteAnnotationCoordinates_V1 (object) or string or PoseCoordinates (object) or Array of PolygonCoordinates_V1 (objects) or Array of PolylineCoordinates_V3 (objects) or EllipseCoordinates_V1 (object) or CubeCoordinates_V1 (object) or Array of APIBoxCoordinates (any) or ItemDescriptionCoordinates (object) or IRefImageAnnotationsType (object) (APIAnnotationCoordinateTypes)
attributes
Array of strings
object (APIMetadata)
existingChildrenIds
Array of strings
source
string (RequestSource)
Enum: "ui" "sdk" "other" "system" "unknown"
property name*
additional property
any
Responses
200

Ok

post/items/{itemId}/annotations
Request samples
application/json
[ ]
Response samples
application/json
[ ]